Copyright: ® 1993, 1994 Solutionsoft


HelpBreeze Features

Overview	Show HelpBreeze Toolbar

The HelpBreeze Topic Wizard

Interface to Help Compiler

Help Topics

Topic Groups and Browse Sequences

Hypertext Jumps and Pop-up Definitions

Graphics

Bullet Points and Numbering

Secondary Windows

Help Macros

Custom Help Buttons

Reporting

Conversion from Help Files to Printed Documentation

Conversion from Printed Documentation to Help Files

Context-Sensitive Help Support

New!  HelpBreeze - Work Group Edition Features

HelpBreeze Menu and Toolbar Commands

Documentation and Support

System Requirements


HelpBreeze Features - Overview

Intuitive, visual dialogs for creating/inserting help topics, hypertext jumps, pop-up definitions and bitmap graphics.  All help file elements can be edited/modified using HelpBreeze commands.  No need to worry about the specifics of the formatting required by the help compiler.

The Topic Wizard automatically creates any number of fully formatted help topics based on a list of topic titles.

Point and click definition for all help compiler options and settings.

Help files can be compiled in the background and tested without leaving Word for Windows.

Includes the Windows help compiler, Hotspot Editor (SHED.EXE) and Multi-resolution Bitmap Editor (mrbc.exe).

Complete support for the advanced features of the Windows 3.1 help system, including help macros, custom buttons and secondary windows, as well as DLL-based routines and embedded windows.

Visual tools for defining macros, custom buttons and secondary windows insulate the author from programming details and allow non-technical users to develop sophisticated help systems.

Hypertext links can be tested and used for navigation without compiling the help file.  A double click of the mouse executes the jump within Word for Windows.

Automated conversion from help files to printed documentation and from existing Word documents to help files.

The standard Word for Windows bullet tool can be used to apply bitmap bullet points in a variety of styles.

Automated generation of printable reports listing all topics and hypertext links.

Existing RTF and help project (.HPJ) files created with Word for Windows or other applications can be imported seamlessly into HelpBreeze.

Complete support for generating identifiers for context-sensitive help, or utilizing the identifiers in an existing include (.H) file.

Menus and toolbar icons can be easily customized.


The HelpBreeze Topic Wizard

The HelpBreeze Topic Wizard (requires Word 6.0)

____________________________________________________________
"...[The HelpBreeze] Topic Wizard...is the 'pièce de résistance' in a package already more than complete." - Windows OnLine Review, January 1994

 "This powerful, easy-to-use Wizard alone makes HelpBreeze well worth the price." -Windows Tech Journal, March 1995

The HelpBreeze Topic Wizard is a powerful, automated tool for creating help topics.  Using the Topic Wizard is similar to using a database application to generate a report or print mailing labels.  You specify a list of topic titles and choose a layout for the topics; the Wizard will then expand the list of titles into a fully formatted series of topics starting at the current location of the cursor.

A significant advantage of using the Topic Wizard is that it will guarantee consistency of formatting in the topics you create.  This is a very important consideration in creating a professional-quality help system.  Once the Topic Wizard has finished creating your topics, you simply fill in the blanks with your own text and/or graphics.

Key features

Choose from several pre-defined topic styles or lay out your own completely custom format for your topics.

Enter the titles for your topics directly in the Wizard dialog box or import a list of titles from any text file.

Instantly create an "index" topic with hypertext buttons which scroll the user to the proper section of an alphabetic list of entries.

Automatically create related topics to be displayed in secondary or pop-up windows for each of the primary topics in the series.  Related topics can be useful for displaying an example or illustration which supplements the information in the primary topic.

Automatically create fully formatted topics for documenting programming language functions and macros.  The Topic Wizard will parse the syntax of a list of functions or macros and create a reference topic, complete with title, keyword, function syntax, and a custom table for documenting arguments.  Click here to see an example.

Automatically add a toolbar with Close, Copy and Print buttons to topics displayed in secondary windows.


MyCFunction Function

Example

int PASCAL _export MyCFunction(int arg1, char * arg2, long arg3) ;

<your text>

Argument	Description
int arg1
char * arg2
long arg3
_________________

See also

Note:  Everything above this line was created automatically by the Topic Wizard.  In this example, we used the Wizard to read a list of functions in a standard C/C++ header file and then create a series of help topics to document these functions.

The function prototype which corresponds to this topic appeared as follows:

int PASCAL _export MyCFunction(int arg1, char * arg2, long arg3) ;

The ability to automatically create specification topics from a list of functions or macros makes the Topic Wizard a powerful tool for documenting programming language interfaces or creating specifications for complex software development projects.  Special support is provided for generating function documentation from files in C/C++ format--even if these files include extraneous information such as comments and compiler directives.


MyCFunction Example

<your text>

Note:  The Topic Wizard can automatically create related topics to be displayed in secondary or pop-up windows for each of the primary topics in the series.  The Wizard automatically adds a toolbar with Close, Copy and Print buttons to topics displayed in secondary windows.


The Topic Wizard allows you to automatically create topics in a variety of formats.  The option shown here creates an "index" topic in which the user can scroll through a list of entries using the alphabetic buttons at the top of the screen.


Interface to Help Compiler

Use any version of the Microsoft help compiler (HC31, HCP, HC30).

Point and click to define all compiler options and help project file settings.

Compile your help file in the background while you continue to work.

Double click any help compiler message to jump directly to the topic containing the error (in any document).

HelpBreeze includes the help compiler.


Help Topics

Convert existing text to a help topic with a few clicks of the mouse.

Use context strings, browse sequences and keywords automatically suggested by HelpBreeze and/or define your own.

Define browse sequences relative to other topics by pointing and clicking.  You can define browse sequences on a topic-by-topic and/or global basis.

Optionally select context string identifiers from an existing include (.H) file.  HelpBreeze tracks and checks identifiers which have been implemented in the help file.

Visually define topic entry macros and specify the state and actions for custom help buttons.

Attach topics to specific help windows.

Point and click to define and edit topic aliases.

Easily define non-scrolling regions.

Use the Undo Topic command to reverse topic formatting.


Topic Groups and Browse Sequences

Define, renumber and reorder browse sequences on a global basis using drag and drop positioning.

Automatically create a parent topic with a hypertext jump to each topic in the group.


Hypertext Jumps and Pop-up Definitions

Define hypertext jumps by selecting the hotspot text and choosing the target topic from a global list.

Quickly find the proper target topic in large help files (which may contain hundreds or even thousands of topics) by searching for identifiers containing any embedded string of characters.

Use automated search and replace to convert multiple occurrences of the selected text to jumps or pop-up definitions.

Define new topic identifiers at the time the hypertext link is created.  HelpBreeze tracks and flags undefined context strings and allows the user to select the identifiers from a list when the corresponding topics are created.

Use secondary windows for jumps.  Visually define the size, position and colors of windows at the time you create or edit the jump.

Execute a jump or pop-up within Word for Windows by double clicking.  Use the "Go Back" button on the toolbar to return to the previous location.

A note on emulation of hypertext jumps and pop-ups

Specify jumps and pop-ups directed to other help files.

Create hotspot text with custom formatting/colors.

Use the Undo Hotspot command to reverse hotspot formatting.


About Emulation of Hypertext Jumps and Pop-ups

The ability to execute jumps and pop-ups within your document while you are developing your help file is an important convenience.  Some competing help authoring products provide this capability via a separate "test mode."  HelpBreeze, on the other hand, embeds the emulation capability directly in your document.  That means you can execute a jump at any time with a double click of the mouse.

This is an important distinction because we have found that the real value of the emulation capability lies in navigation within your document, rather than just in the ability to test the hypertext link.


The Insert Jump dialog provides point and click support for all hypertext jump options available in the Windows 3.1 help compiler.


Graphics

Insert and edit graphics in any of the formats supported by the help compiler: Windows bitmaps, Windows metafiles, multi-resolution bitmaps, or segmented hypergraphic bitmaps.

View bitmaps while they are being inserted or edited.

Create hotspot graphics linked to hypertext jumps, pop-up definitions or help macros.

Take advantage of seamless integration with the Microsoft Hotspot Editor (SHED.EXE):

Run the Hotspot Editor from within Word for Windows.

Select target context strings from a pick list and define hotspot macros using HelpBreeze's point and click environment.

HelpBreeze includes the Hotspot Editor and Multi-resolution Bitmap Editor.


Bullet Points and Numbering

Create bullet points or numbered lists using Word for Windows' standard bullet and numbering commands.

Use standard Word for Windows bullet points or select from a variety of bitmap bullet styles.

Design your own bullet point styles and apply them using the Word bullet tool.

Automatically create "jump buttons" by applying bullets to any list of hypertext jumps.

Most help files rely heavily on bullet points and numbering because of the need to concisely present information in a very structured way.  Professionally designed help systems often use bitmaps for bullet points because they tend to look better than the standard Word for Windows round bullets.  Many help file authors use several bullet styles in order to provide the user with visual cues.

However, inserting individual bitmap references for every bullet point in your help file can be tedious.  That's why we expanded the normal Word for Windows bullet command to support bitmap bullet points.  You simply choose a bullet style, select one or more paragraphs in your document and click the bullet icon on the Word for Windows toolbar.


The Select Bullet Point Style dialog allows you to select from a variety of bitmap bullet point styles.  Once you have selected a style, you simply use the Word for Windows bullet tool in the normal fashion to create bullets in your document.


Secondary Windows

Define the size and position of the main and secondary windows by simply moving actual-size windows in the normal fashion.

Visually define and inspect main and non-scrolling region colors.

Use the window editing tools to generate macro code to move windows to any size and position.


The Window Tools palette floats over an actual-size representation of the help window you are defining.  You simply move the window to the proper size and position, set parameters such as background colors and the window title using the tool palette, and then press OK to save the window definition.


Help Macros and Embedded Windows
Help Macros

Use HelpBreeze's visual interface for specifying and editing hotspot macros, topic-entry macros, and start-up macros in the [CONFIG] section of the help project file.

Point and click to construct help macros.  Built-in syntax checking eliminates errors.  Automatic support for multiple macro strings and nested macros makes it easy to define complex macros.

Use the extendible interface to provide point and click support for DLL-based add-in macro routines and embedded windows.

Test and step through macros directly from the Macro Editor during development--without re-compiling the help file.

Use automated search and replace to convert multiple occurrences of selected text to hotspot macros.


Custom Help Buttons

Define custom buttons visually, by clicking a representation of the button and then selecting the corresponding action.

Create buttons which become visible/invisible or enabled/dimmed on a topic-by-topic basis.

Change the button action based on the topic being viewed.

Create buttons which jump to a related topic by selecting the destination from a list--no need to understand help macro syntax.

Define help macros to be attached to buttons using the same tool used for defining hotspot, topic entry and [CONFIG] macros.


Reporting

Quickly generate printable reports which list all topics, hypertext links and macros.

List all topic parameters, including context strings, build tags, topic titles, keywords, browse sequences, and topic entry macros.

Use the two-pass report generator to list all jumps/pop-ups to other topics and all jumps/pop-ups from other topics (i.e. both inward and outward jumps).

Sort reports based on any topic parameter.


Conversion from Help Files to Printed Documentation

Automatically create a normal Word document by removing all the help compiler-specific formatting from all or any portion of a topic file.

Automatically insert index entries into the document based on information present in the help file--such as keywords or pop-up definition words.

Automatically convert bitmap references to Word graphics and bitmap bullet points to Word bullet points.


Conversion from Printed Documentation to Help Files

Automatically convert one or more Word documents to a tree-structured help file based on the heading styles present in the document.

Conversion is highly flexible--virtually any existing Word document can be converted.

Automatically include an Up button in the help file.

Automatically convert Word bullet points to any bitmap bullet style.

Once automated conversion is complete, use the interactive commands to further refine the help file.


Context-Sensitive Help Support

Automatically generate context ID include files for C/C++, Pascal and Basic.

Use the context integers which HelpBreeze automatically generates or edit values on a topic-by-topic basis.

Turn off symbol generation for all topics or for individual topics.

Easily define topics based on context string identifiers from any pre-defined include files, such as the ones generated by Visual C++/MFC 2.0 or other code generators/class libraries.  HelpBreeze tracks and checks identifiers which have been implemented in the help file or which have been assigned as an alias.

Point and click support for topic aliases makes it easy to assign multiple symbols in external include files to a single existing help topic.


You can select context strings directly from a pre-defined include (.H) file.  This illustration shows HelpBreeze being used with files created under Visual C++'s context-sensitive help option.  The symbols next to the identifiers ( [image] or [image]) indicate that a topic corresponding to a given identifier has already been implemented in the help file, or that the identifier has been assigned to an existing topic as an alias.  This makes it easy to see which identifiers in the list have already been handled.


System Requirements
HelpBreeze System Requirements

A PC running Windows 3.1 with a VGA (or higher) video adapter.

Microsoft Word for Windows 6.0x or 2.0x.

Use of the Slide Show for WinHelp add-in DLL requires a Windows resource editor.

HelpBreeze includes the Windows 3.1 help compiler, Hotspot Editor (SHED.EXE) and Multi-resolution Bitmap Editor (mrbc.exe).

The international version of HelpBreeze works with German, French or English Word 6.0x.  English only support for Word 2.0x is also included.

HelpBreeze - Work Group Edition requires Word 6.0x.


Documentation and Support

Professionally printed, 200+ page user's manual.

Comprehensive on-line help.

Tutorial and complete set of examples.

Free technical support via phone, fax or electronic mail.


HelpBreeze - Work Group Edition Features

HelpBreeze - Work Group Edition is an enhanced version of HelpBreeze with special support for development teams working on large help systems.

Divide large help systems into manageable modules which can be compiled and tested individually.

Easily create hypertext links between modules (.HLP files) by selecting the target topic from a list.

Test links between modules without having to compile the entire large-scale help system.

Share the information necessary to create inter-module links between team members with or without a network.

Use formal software release techniques to manage the development process.

Once individual modules and their inter-relationships have been thoroughly tested, use HelpBreeze - Work Group Edition's automated tools to consolidate the modules for the final help system build.

Also use the work group tools to easily create help systems consisting of a linked series of .HLP files.

Click here to see an illustration showing how the work group tools are used.

HelpBreeze - Work Group Edition is priced at $379 per user ($449 for the international version).  Site licensing and volume discounts are also available.

Upgrades from the standard version of HelpBreeze cost $99.

HelpBreeze - Work Group Edition requires Word 6.0 or later.


1.  Dividing a Large Project into Modules

In this example, a large project dealing with U.S. history has been divided into three separate modules: The Revolutionary War, the Civil War years, and the 20th Century.  Each module will be compiled and tested as a separate Help file, but the work group tools will make it easy for the authors to create hypertext links between the modules.


2.  Sharing Information among Team Members

In order to make it easy to create links between modules, the HelpBreeze work group files are shared among the members of the team.  The work group files define the interface between the modules and make it possible for authors to create inter-module links by selecting the target topic from a list; it is not necessary to share the RTF source files.  In this example, a network server is used, but the files could also be copied and distributed via diskettes, e-mail, etc.


3.  Creating Links between Modules

The Work Group Palette can be accessed from the dialog boxes used to create hypertext jumps and pop-ups.  To create a link to another module, you simply choose the appropriate module, and the context strings from the selected module will immediately be displayed in the Jump/Pop-up dialog box.  Then you define the jump or pop-up in the normal fashion.


4.  Building the Final Large-Scale Help file

Once the individual modules have been completed and tested, the source files can be compiled into a single large-scale Help file.  HelpBreeze provides tools to automatically prepare the individual modules to be consolidated into a single title.


HelpBreeze
HelpBreezeTM

		Introducing HelpBreeze
		HelpBreeze Features
		Slide Shows and Animation
		Ordering Information


Topic 2
Introducing HelpBreeze	Trademark Acknowledgment

"[HelpBreeze] includes the right set of well implemented features. Well written manual and good support. Highly recommended."	- Ted Kahn,Visual Basic Programmer's Journal, Feb-Mar 1994

 	"HelpBreeze stands out among similar products..."	- InfoWorld Test Drive, April 11, 1994

HelpBreeze turns Microsoft® Word for WindowsTM (version 6.0 or 2.0) into a complete, integrated environment for developing Windows help files.  Whether you are an experienced or beginning help file author, HelpBreeze will make it easy for you to develop sophisticated help systems which utilize all the capabilities of the Windows 3.1 help engine.

Since its introduction in October 1993, HelpBreeze has quickly become recognized as a leading contender in the help authoring tools arena.  Organizations currently using HelpBreeze to develop professional-quality help systems include AT&T, Deloitte and Touche, Digital Equipment Corporation, Fidelity Investments, Gateway 2000, Hewlett-Packard, IBM, Price Waterhouse, Siemens and many others--both large and small.

Version 1.6 leverages the full power of Microsoft Word 6.0.  With the addition of a number of new features, most importantly the HelpBreeze Topic Wizard--a unique tool which automatically structures and formats help files--HelpBreeze sets a new standard for Windows help authoring tools.

For more information, please see:

About this Help File	A Few of the Organizations Currently Using HelpBreeze...

Developing On-Line Help for Windows Applications Using HelpBreeze

Creating On-Line Documents and Presentations Using HelpBreeze


About this Help File

This demonstration help file contains complete information about HelpBreeze.  In order to describe the feature set completely, we have used some technical terms associated with help file authoring.  Pop-up definitions are provided for many of these terms.

This file was, of course, created using HelpBreeze.  Here are a few points to keep in mind as you explore it:

A number of topics are accompanied by screen-shot illustrations. You can view these by pressing the "Picture" button in the top-right corner of the topic screen.

 	The Browse button on the Buttonbar displays a palette which allows you to quickly move to any portion of the help file.  This palette can be contracted to take up less space by using the toggle control in the top-right corner.

The Up button on the Buttonbar will take you to the current topic's "parent"--where you can view a list of related topics.

The Toolbar button on the Buttonbar displays an illustration of the HelpBreeze Toolbar.  You can click the icons on the toolbar to get more information about HelpBreeze commands and features.

Anyone can produce help systems similar to this one using HelpBreeze.  A comprehensive set of examples which incorporate all the techniques used in this file is included with the product.


Developing On-Line Help for Windows Applications

HelpBreeze provides unparalleled support for developing help files for Windows applications.  The comprehensive, point and click interface makes it possible for individual developers and small groups to produce help systems of the same caliber as those designed by large organizations.

You can use HelpBreeze to develop help systems for any development platform, including language compilers, Visual Basic, Windows databases and applications such as Excel.

Context-Sensitive Help

Two approaches are available for building context-sensitive help support into applications:

You can use HelpBreeze to automatically generate context identifier include files formatted for C/C++, Pascal or Basic.  You can then use these identifiers in your code to set up the proper linkage between your application and the help file.

You can use a pre-defined include file provided by the programmer or created using an automated development tool, such as a code generator or Microsoft Visual C++.  HelpBreeze allows you to easily select identifiers from an include file and use them as context strings in your help file or assign them as topic aliases.

For more information, please see Context-Sensitive Help Features.

Conversion between help files and printed documentation

Two-way automated conversion between help files and printed documentation makes it easy to use the same material as the basis for both the on-line help system and the user's guide.

If you already have a manual in Word format, you can easily convert it to a help system using the Convert Document to Help File command.

On the other hand, you may prefer to develop your help file first.  This allows you to easily and inexpensively distribute essential information to beta testers and other early users during the development of your application.  Once your software has stabilized, you can use the Convert to Document command to transform your help file into a normal Word document which you can use as the basis for a user's manual.


Using HelpBreeze to Create On-Line Documents and Presentations
Creating On-Line Documents and Presentations

While the Windows help engine was originally conceived to provide on-line help for applications, many users are beginning to realize that help files are a powerful medium for presenting and distributing all types of information.  As PC Week recently noted:

"...a growing number of corporate developers are using Windows Help as a delivery mechanism for hypertext documents.  These developers are compiling documents such as employee manuals, regulatory texts and mainframe-access procedures into Help format."

Consider the following facts:

Windows help files can be distributed royalty-free and can be viewed by any Windows or OS/2 user.

Compiled help files are generally much smaller than the source documents they are created from.  In cases where graphics are used heavily, the difference in size can be a factor of 10 or more.  This size advantage--together with the fact that the viewer software doesn't need to be distributed--makes help files ideal candidates for distribution via diskettes, electronic mail, or download from a BBS, server or information service.

The Windows help engine's hypertext and search capabilities make help files an ideal medium for on-line reference documents or any application where the user needs to be able to access information quickly.

Help files are especially useful in cases where information is subject to change frequently, since electronic documents are easier to update and much less expensive to distribute than their paper counterparts.

Help files can be a highly effective way to develop marketing information documents and electronic brochures.  Presentations using full color graphics can be cost-effectively developed for both high and low volume applications--or even customized for individual prospects.  With HelpBreeze, effects such as slide shows, animation and sound can easily be added to help files, resulting in presentations with even more impact.

The help engine is so powerful that Microsoft used it as the basis for its Multimedia Viewer product, which is used to develop CD-ROM-based multimedia packages such as the Encarta Encyclopedia.  Using the Windows help system, authors can develop applications which share many of the capabilities of full-fledged multimedia packages and can target the entire Windows installed-base--rather than just the minority of systems equipped with CD-ROM drives and other add-on hardware.

With HelpBreeze, authors can easily convert existing documents into help format and then use the interactive commands to refine the help file into a compelling on-line presentation.


"Windows Help Becomes Development Tool," by Paul Bonner, PC Week, Feb. 15, 1993, v10 n6, p. S28.


Glossary of Key Terms

Alias

Browse Sequence

Context-Sensitive Help

Context String

Embedded Window

Help Compiler

Help Project (HPJ) File

Hotspot

Include Files (Context ID)

Keyword

Macro

Topic

Topic File


Alias

An alias is used to assign more than one context string identifier to an existing topic in the help file.

If you are implementing context-sensitive help in an application with the help of a code generator, you may find that you don't want to create a separate help topic for every symbolic identifier generated.  You can use topic aliases to assign multiple context string identifiers to a single topic in your help file.  For example, if a unique symbol is generated for every error message box in your application, you might prefer to assign a number of these identifiers to a generic help topic covering errors.

HelpBreeze includes point and click support for defining and editing topic aliases.


Browse Sequence

The Browse Sequence identifier assigned to a help topic determines the order in which the topic appears when the user clicks the browse (<< and >>)  buttons at the top of the WinHelp screen.

HelpBreeze makes it easy to work with browse sequences; you can set the viewing order simply by selecting a group of topics and dragging them into the desired sequence with the mouse.


Context String

Every topic in a help file is assigned a unique identifier called a context string.  WinHelp uses context strings to identify the target topic for hypertext jumps and pop-up definitions.

Context strings are usually chosen to reflect the topic title.  For example, a topic about "The Insert Object Command" might have a context string like "idh_insert_object."  HelpBreeze will automatically suggest a context string based on the topic's heading.

HelpBreeze maintains a global database of all the context strings in the help file so jumps and pop-ups can be defined by selecting the proper target identifier from a list.


Context-Sensitive Help

Context-Sensitive Help refers to an application's ability to display help information which is tailored to the user's current situation.

Context-sensitive help is often implemented so that the user can press the F1 key and receive help on his or her current task.


Embedded Window

An embedded window is a rectangular region in a help topic whose appearance is controlled by a Windows dynamic link library (DLL), rather than by the help engine itself.  Embedded windows allow programmers to create WinHelp add-ins to customize the appearance of help files.

The Slide Show for WinHelp add-in included with HelpBreeze uses embedded windows to create slide shows and animations in help files.  HelpBreeze's customizable Insert Embedded Window command, provides point and click support for defining embedded windows.


Help Macros

Help Macros are functions which you can use within a help file.  For example, you can use macros to create custom buttons on the WinHelp toolbar or to launch another Windows application from within the help system.

Macros can be executed in response to the user clicking a hotspot, or they can be run automatically when the help file is first opened or when a given topic is first displayed.

One of the help engine's most powerful features is the ability to use custom macros located in Windows dynamic link libraries (DLLs).  This allows programmers to develop WinHelp add-ins which customize and expand the capabilities of the help system.

HelpBreeze includes complete point and click support for constructing help macros, and the interface is easily extendible to support add-in DLLs.

For more information, see Help Macro Features.


Help Topic File

Help Topic files are the individual Rich Text Format (.RTF) documents used by the help compiler to generate the help file.  With HelpBreeze, you work with source documents in normal Word (.DOC) format.  When you compile your help file, HelpBreeze will automatically create the RTF format documents required by the help compiler.

HelpBreeze allows up to 200 topic files per help project.


Help Project File

The help project (.HPJ) file is a plain text file which contains the information the help compiler needs to construct a help file, such as the names and locations of the source documents used in the project and the settings for help compiler options.

With HelpBreeze, you never need to worry about editing this file directly.  All aspects of the help project file can be controlled directly through dialog boxes and visual tools--including advanced features, such as secondary windows and topic aliases.  HelpBreeze generates a help project file automatically when you compile your help file.

You can also directly open and use any help project file created outside of HelpBreeze.


Help Compiler

The Microsoft Help Compiler is used to process your help topic files and produce the finished help file.  Three versions of the help compiler are currently available:

HC.EXE	The Windows 3.0 help compiler

HC31.EXE	The Windows 3.1 help compiler

HCP.EXE	A protected-mode version of HC31.EXE which allows you to build larger help files

HelpBreeze supports all three versions of the help compiler; however, advanced features such as macros and secondary windows require a Windows 3.1 compiler.


Keywords

Keywords are used in the WinHelp search facility.  A list of keywords (or search words) appears when the user clicks the Search button on the WinHelp toolbar.

HelpBreeze allows you to define keywords either at the start of help topics or at any point in the topic text.


Help Topic

A Help Topic is a "page" within the help file.  Each topic deals with a specific subject and has a context string which uniquely identifies it.  Topics may also serve as groups, which contain lists of hypertext jumps or pop-ups linked to related topics.

Users can move to a help topic by clicking on a hotspot linked to a hypertext jump or pop-up definition, by using the browse buttons on the toolbar, or by using WinHelp's search capability.


Hotspot

A hotspot is an area in which the user can click to perform some action.  Hotspots can be linked to hypertext jumps, pop-up definitions or help macros.  A hotspot can be formatted as colored text or as a graphic.


Include Files

Context Identifier Include Files are files which set up a correspondence between the context strings used to identify topics within the help file and context integers--which are used to identify topics to other Windows applications.

Include files are used to implement context-sensitive help in Windows applications.  HelpBreeze can automatically generate include files, or use existing include files created by a programmer or by other applications.  For details, see Context-Sensitive Help Support.


Secondary Help Windows

Secondary windows allow you to display topics in individual windows, separate from the main help window.  You can create secondary windows in a variety of sizes, positions and colors.  The browse palette in this help file (click the Browse button on the toolbar) is an example of a secondary window.

HelpBreeze includes visual support for defining and editing secondary windows; see Secondary Help Window Features for details.


Resource Editor

A Windows resource editor is an application which is used to design and modify the visual components of Windows applications such as bitmaps, strings, icons and dialog boxes.

You do not need to be a programmer to use a resource editor; most of these products are as easy  to use as any Windows drawing/painting program.  Resource editors are included with all the major Windows language compilers.  Examples include Borland's Resource Workshop and Microsoft's AppStudio.


Slide Shows and Animation

HelpBreeze includes Slide Show for WinHelpTM, an add-in dynamic link library (DLL) which allows you to customize your help files with slide shows, sound and simple bitmap animations.  Licensed users may distribute this DLL with their help files royalty-free.

For more information, please see:

Slide Show Features

Slide Show Demo

Quiz Demo

"Radio Button" Demo

Animation Demo

256-Color Graphic Demo

For more examples of WinHelp animation, you may wish to obtain a copy of Windows Online Review (WOLR). WOLR is an electronic magazine in WinHelp format which includes reviews of commercial windows software.  Issue #81 (January 1994) includes a review of HelpBreeze 1.6 and uses the Slide Show for WinHelp DLL to implement animation in the magazine.  WOLR is distributed to BBS systems throughout the world.  You can obtain a copy of WOLR81.ZIP from a local BBS, from the WINSDK forum on CompuServe, or from ftp.cica.indiana.edu (or international ftp sites which mirror it) on the Internet.


Slide Show for WinHelp Features

Standard VCR-style buttons allow the user to directly control the presentation.

A complete set of custom macros allows presentations to be controlled from hotspots.

A text caption can be added to each slide in the presentation.

Each slide can be defined to be a jump, pop-up or macro hotspot.

A Windows sound file can be attached to each slide and played automatically when the user views the slide.

Bitmap movies and animations can be created and played in a variety of sequences, including continuous looping, auto-reverse and random selection.

Presentations can be easily defined using any Windows resource editor, together with HelpBreeze's point and click support for custom macros and embedded windows.

256-color graphics can be displayed either as static images or as part of slide show presentations.


 Automatically Converting a Word Document to a Help File

About this example

Use the controls below to view a brief slide show on converting a document to a help file.

Click any slide for more information.


This example demonstrates a standard slide show:

The short version of the toolbar is used.  This allows the user to step through the presentation one slide at a time.

A text caption has been added to the right of each slide.  (Captions can be positioned at any edge of the graphic.)

Each slide is defined as a pop-up definition.  This is very useful for providing the user with additional information.


You can also use the conversion command to consolidate multiple documents into a single help file.

The heading styles in the document must be used in a consistent fashion, but the document doesn't need to be symmetric.  Some sections may have headings nested more deeply than others.


HelpBreeze will automatically convert any Word for Windows index entries in the document to keywords.  You can choose to either group keywords at the beginning of each topic or insert a spot reference keyword at the actual location of the index entry.


HelpBreeze will convert higher-level heading styles into parent  topics which have a hypertext jump to each of the individual topics in the group.

The optional Up button takes the user directly to a given topic's parent.  For example, clicking the Up button while the "Cats" topic is being viewed would cause the "Mammals" topic to be displayed.


Quiz
Flag Quiz

About this example

Click on the name of the country whose flag is displayed.  If you answer correctly, a new flag will be shown.

Start Over

Belgium

France

Angola

Germany

Mexico

United Kingdom


This example demonstrates the use of hotspot macros to control and query a slide show presentation:

No toolbar or caption is displayed with the slides.

Macro hotspots are used to determine whether the correct slide is currently displayed and to advance to the next flag when the user answers correctly.

A pop-up window with a simple animation is displayed when the user answers correctly.


Sorry...

 Try again !


Right !

You have finished!


About this example


This example demonstrates a bitmap movie consisting of three frames:

The full toolbar is used.  This allows the user to stop and play the presentation, as well as set the speed and sequence.

The same animation is used in the opening screen without the toolbar.


256 Color Bitmap
256-Color Graphic

The Windows help engine is limited to 16 color graphics.  You can use Slide Show for WinHelp to display 256-color bitmaps in full color, either as static images or as part of a slide show presentation.

A 256-color display is required to view this graphic properly.


 Introduction

 Slide Shows and Animation

 Feature Overview

 Topic Wizard

 Interface to Help Compiler

 Help Topics

 Bullet Points & Numbering

 Browse Sequences

 Jumps and Pop-ups

 Graphics

 Secondary Windows

 Help Macros

 Custom Help Buttons

 Reporting

 Help Files -> Documentation

 Documentation -> Help Files

 Context-Sensitive Help

 Menu and Toolbar Commands

 System Requirements

 Glossary


HelpBreeze Menu and Toolbar Commands

Show HelpBreeze Toolbar

Menu	 	Function

File

Import Topics	Import existing help topic files

Convert Document to Help File	Automatically convert a Word document to a help file

Open Help Project File	Open the help project file

Edit

Undo Hotspot	Undo hotspot formatting

Undo Topic	Undo topic formatting and delete topic parameters

Goto Topic	Jump to any help topic

Group	Define/Edit a group of topics or a browse sequence

View

Help Compiler Errors	View help compiler error log

Insert

Help Topic 	 	Insert or edit a help topic

Hypertext Jump 	 	Insert or edit a hypertext jump

Pop-up Definition 	 	Insert or edit a pop-up definition

Graphic	 	Insert or edit a bitmap (optionally a hotspot)

Macro Hotspot	Insert or edit a hotspot linked to a macro

Embedded Window	Insert or edit a DLL-based embedded window

Mid-Topic Keyword	Insert a mid-topic (spot) keyword reference

Format

Non-Scrolling	Make an area non-scrolling

Select Bullet Style	Select a bullet style -- either standard WinWord or bitmap

Tools

Compile Help File 	 	Generate RTF files and run the help compiler

View Help File 	 	View your help file using WinHelp

Set Help Project 	 	Select a help project and set HelpBreeze preferences and compiler options

Delete Item	Delete a topic file or context string from the help project

Convert to Doc	Convert a help topic file to a form suitable for printed documentation

Hotspot Editor	Launch the Microsoft Hotspot Editor (SHED.EXE)

Topic Report	Generate a report showing topics and jump linkage

Topic Wizard	Use the Topic Wizard to automatically create topics

Help

HelpBreeze Help	Display the HelpBreeze on-line help

About HelpBreeze	Display the HelpBreeze About dialog box

Floating Help Palette	 	Display the HelpBreeze floating help palette


Ordering Information
HelpBreeze Ordering Information	How to contact us

 Only $279

International Version (supports localized versions of Word 6.0) US $349

Please see our Order Form for details.

HelpBreeze is backed by an unconditional 30 day money back guarantee.

Call (408) 736-1431, return our order form with your check, or FAX to (408) 736-4013.

Order Now!

If you are located outside the United States, please see A Special Note to International Customers.


How to Contact Solutionsoft

 	Solutionsoft	Phone: 	(408) 736-1431

370 Altair Way	FAX:	(408) 736-4013

Suite 200	E-Mail:	CompuServe 75210,2214

Sunnyvale, CA  94086	Internet 75210.2214@compuserve.com


Special Note to International Customers
A Special Note to International Customers

A significant percentage of HelpBreeze sales have been to customers located outside the United States.  The growing list of HelpBreeze users currently includes individuals and companies in the following countries (countries shown in red text have a local dealer; click the country name to see contact information).

Australia	Germany	Mexico	South Africa
Belgium	Iceland	Netherlands	Spain
Canada	Italy	New Zealand	Sweden
Finland	Japan	Norway	Switzerland
France	Luxembourg	Portugal	United Kingdom

Shipment by air mail costs US$12 (US$8 to Canada) and normally takes about 10 days.  International Express Airmail (4 business days) is also available to most countries and costs $30.  These charges apply to a single copy of HelpBreeze; please contact Solutionsoft for larger quantities.  The easiest way to place an international order is to FAX our order form with your credit card number.  Your order will generally be shipped within 24 hours.

Technical support is available by phone, fax or electronic mail.  Fax or e-mail questions will normally be answered within 24 hours.

Important Note

The standard version of HelpBreeze requires an English Language version of Word for Windows 6.0 or 2.0.

The international version includes full support for the French, German and English versions of Word 6.0x.  English-only support for Word 2.0x is also included.  The international version automatically adapts to the localized version of Word 6.0x being used--no configuration or setup is required.  The documentation and program interface for the international version are in English.  Support for other languages will be added to the international version in the near future.  If you require support for a localized version of Word 6.0 not listed above, please contact us for availability prior to placing your order.


Downsizing Systems GmbH

Florlansgasse 4

D-50737 Köln

Germany

Tel:   0221 740 09 86

Fax:  0221  74  71 78


Philog AG

Eggfluhstrasse 3

CH-8918 Unterlunkhofen

Switzerland

Tel:   057 343 141

Fax:  057 343 151


Grey Matter, Ltd.

Prigg Meadow

Ashburton

Devon

TQ13 7DF

England

Tel:   0364 654100

Fax:  0364 654200


Solutionsoft Order Form
Solutionsoft Order Form	Click here to print this form

Return this form to:	Solutionsoft	Phone: 	(408) 736-1431

370 Altair Way	FAX:	(408) 736-4013

Suite 200	E-Mail:	CompuServe 75210,2214

Sunnyvale, CA  94086	Internet 75210.2214@compuserve.com

Ship To:	Name: ______________________________________________________

Company: ___________________________________________________

Address: ____________________________________________________

____________________________________________________________

____________________________________________________________

__________________________________   Country: _________________

Phone: ________________________  FAX: ________________________

Please tell us where you heard about HelpBreeze:  ________________         int-03

Product	Unit Price	Quantity	Total

HelpBreeze (English Word 6.0 or 2.0 Only)	$279

HelpBreeze International Version	$349
(French, German or English Word 6.0)

HelpBreeze - Work Group Edition (English Word 6.0 Only) 	$379

HelpBreeze - Work Group Edition, International Version	$449
(French, German or English Word 6.0)

Sales Tax (California residents only)

Shipping and Handling (choose one)
U.S. only - Priority mail	   $7
U.S. only - Second day air	 $10
U.S. only - Overnight	 $14
Canada - Air mail	   $8
All other International - Air mail 	 $12
International Express Air mail 	 $30

TOTAL

Credit Card Information

__Visa  __Mastercard	Full Name on Card ________________________________

Card Number:  __  __  __  __  __  __  __  __  __  __  __  __  __  __  __  __

Expiration Date:  	Month  __  __  Year  __  __

Date Ordered ___________	Signature _________________________________

Checks

Checks or money orders should be made payable to Solutionsoft and must be in U.S. dollars drawn on a U.S. bank.  Most international money orders and bank drafts drawn in U.S. dollars can also be accepted.

Purchase Orders

Purchase orders can be accepted from recognized, credit-worthy U.S. corporations, agencies and schools.  Credit reference information may be required to set up an account.  Terms: 30 days net.

Returns

If you are not satisfied with any product, you may return it within 30 days for a full refund (not including shipping and handling charges).  We reserve the right to assess a 10% restocking fee if the printed documentation is not returned in marketable condition.

Technical Support

Free technical support by phone, FAX or electronic mail is included with HelpBreeze.  We reserve the right to modify our technical support policies and pricing in the future; however, all customers will receive a minimum 6 months of free technical support.


 Help Macros      [image] Custom Buttons      [image] Embedded WIndows  	About this example

Choose one of the items above and then click the illustration to see more information.


This example demonstrates a slide show controlled via hotspot macros.

The main illustration is set by clicking one of the hotspots at the top of the screen.

A second set of slide shows is used to implement "radio buttons" by displaying a check mark next to the selected option.

Each slide is defined as a pop-up definition.


The Macro Editor provides a complete point and click environment for constructing help macros.  Built-in syntax checking and automatic support for nested macros and multi-macro strings makes it easy to create even the most complex macros.

You can access on-line help on any macro by pressing the Help On button.

The Test button allows you to step through macros directly from the editor--without having to re-compile your help file.

The Macro Editor's interface is fully extendible to support WinHelp add-in DLLs.


The Button Editor allows you to define and edit custom WinHelp buttons visually.

Create new buttons with a few clicks of the mouse.

Attach an action to a button by clicking the button and then selecting an option.  For a jump or pop-up button, you simply select a destination from the list.  For a macro button, you can use the Macro Editor to define an action.

Edit the action and state of buttons on a topic-by-topic basis.  For example, you can create an Up button similar to the one in this help file.  You can define buttons which become disabled or even disappear when they are not relevant to the current topic.


Embedded windows allow you to customize the appearance of your help file by using add-in DLLs.  HelpBreeze's embedded window command provides a fill-in-the-blank interface--no need to worry about the cryptic formatting required by the help compiler.

This illustration shows the embedded window command being used with the Slide Show for WinHelp DLL.  Either the user or the DLL developer can easily extend HelpBreeze's interface to provide similar support for any embedded window.


Trademarks

The following trademarks are referenced throughout this document:

HelpBreeze, ViewerBreeze and Slide Show for WinHelp are trademarks of Solutionsoft.

Microsoft is a registered trademark and Windows, Word for Windows, Visual C++, Visual Basic, Encarta, and Multimedia Viewer are trademarks of Microsoft Corporation.

Borland is a registered trademark and Resource Workshop is a trademark of Borland International, Inc.

The Windows Magazine recommended seal and logo are the property of CMP Publications, Inc.

All other company and product names are the property of their respective owners.


A Few HelpBreeze Customers...

 3M Company

 AccuSoft

 Advantek

 American Express Company

 Andersen Consulting

 Apple Computer

 AT&T

 BellSouth Telecommunications

 Blue Cross/Blue Shield

 Boole & Babbage

 Booz Allen & Hamilton

 State of California

 Government of Canada

 Ciba-Corning

 Commission of the European Communities

 State of Connecticut

 Coopers & Lybrand

 DacEasy, Inc.

 Dell Computer Company

 Deloitte & Touche

 Dictaphone Corporation

 Digital Equipment Corporation

 Dow Chemical Company

 Eaton Corporation

 EDS

 Eli Lilly & Company

 Ernst & Young

 Fidelity Investments

 Fujitsu Computer Products of America

 Gateway 2000

 General Electric

 Glaxo Canada

 Harris Corporation

 Hewlett-Packard

 Hewitt Associates

 Honda Motor Company

 Honeywell

 IBM

 Idaho Power Company

 Intel Corporation

 JC Penney

 John Hancock Mutual Life

 John Wiley & Sons

 Kraft General Foods

 Lloyd's Bank

 Lowe's Companies

 LSI Logic

 McCaw Cellular

 Government of Mexico

 State of Michigan

 Microsoft

 Merck

 The Molson Companies

 Novell

 Okidata Corporation

 Oklahoma State University

 Oracle Corporation

 Oregon State University

 Pacific Bell

 Phoenix Technologies

 Price Waterhouse

 Prudential Insurance Company

 Rand-McNally

 Reader's Digest

 RCA

 ROLM

 Siemens

 Sony Electronics

 Sprint

 Sterling-Wentworth Corporation

 Swiss Federal Government

 Sybase Corporation

 Syracuse University

 Target Stores

 Tennessee Valley Authority

 Texas Instruments

 Touche Ross & Company (U.K.)

 Tyson Foods, Inc.

 Unisys Corporation

 United Press International (UPI)

 U.S. Air Force

 U.S. Army

 U.S. Department of the Treasury

 United Technologies Automotive

 University of Canberra (Australia)

 York University (Canada)

 Wang Labs

 Washington State University

 Windows Magazine (CMP Publications)


About the HelpBreeze Toolbar


About the HelpBreeze Toolbar


Set Help Project

Use this command to select or create a help project (.HPJ) file.  This dialog box also allows you to set all help compiler options, set start-up (config) macros, create custom WinHelp buttons and define secondary windows.


Delete Item from Help Project

Enables you to remove a topic (RTF) file from your help project or delete a context string from the global database maintained by HelpBreeze.


Goto Topic

With this command, you can jump directly to any topic in your help project by making a selection from a global list.  If the topic you select is in another Word document (topic file), HelpBreeze will automatically open the document for you.  Since a large help project may contain thousands of topics, a search utility is provided so that you can easily find topic identifiers containing any string of characters.


Edit Topic Groups and Browse Sequences

Enables you to manipulate groups of topics on a global basis.  You can define and renumber browse sequences using drag and drop ordering.  You can also automatically create a "parent" for  a group of topics; this is a very powerful feature for designing hierarchical help systems.


Select Bullet Style

Use this command to select the style you want to use for bullet points in your document.  You can choose either standard Word bullets or bitmap bullets.  Once you select a style, you simply use the regular Word for Windows bullet tool to apply the bullets to your document.


Create or Edit Topic

Allows you to create a new help topic or edit an existing one.  A straightforward dialog box allows you to easily define all topic parameters.


Create or Edit Hypertext Jump

Use this command to create a jump.  Simply highlight the text you want to make into a hotspot, click this icon, and then select the target topic from the list.  Once you have created a jump, you can use it to move around your Word documents using the emulation capability provided by HelpBreeze.


Create or Edit Pop-up Definition

Use this command to create a pop-up definition.  Simply highlight the text you want to make into a hotspot, click this icon, and then select the target topic from the list.  Once you have created a pop-up, you can use it to move around your Word documents using the emulation capability provided by HelpBreeze.


Insert or Edit Graphic

Allows you to insert a graphic in any format supported by the help compiler.  You can optionally define the graphic to be a jump, pop-up or macro hotspot.


Insert or Edit Help Macro

Use this command to insert a macro hotspot which executes one or more WinHelp commands in response to a click from the user.


Insert or Edit Embedded Windows

Allows you to insert or edit embedded window references.  Embedded windows allow you to expand the capabilities of the help system by using add-in DLLs.  The slide shows and animations in this help file are examples of embedded windows.


Insert Mid-Topic Keyword

Allows you to insert a mid-topic (spot) keyword anywhere in your document.


Compile Help File

Starts the help compiler and builds your help file.  If you wish, you can compile your file in the background--so you can keep working while compilation takes place.


Display Compiler Errors

Displays any errors or warnings detected by the help compiler.  You can double click a compiler message to jump directly to the topic containing the problem.


Run Help File

Lets you view and test your compiled help file.


Go Back

This icon works with HelpBreeze's hypertext emulation capability.  You can use the jumps and pop-ups you create to move around your documents.  The Go Back button takes you back to the location of the last jump or pop-up you executed (this works the same as WinHelp's Back button).  You can click this icon multiple times to move back through the jump history.

Under Word 6.0x, hypertext emulation works seamlessly across document boundaries.  If you click a jump or pop-up linked to a topic in another Word document, the proper file will be opened for you automatically.


Convert to Document

Automatically removes all help compiler-specific formatting from all or part of a document.  This allows you to easily use the material in your help file in printed documentation such as a manual.  This command will also convert keyword entries to Word index entries.


Generate Topic Report

Generates a complete report listing all the topics and hypertext links in your help file.


Run Hotspot Editor (SHED.EXE)

Runs the Hotspot Editor (SHED) so you can create segmented hypergraphics.  The toolbar graphic you just clicked is an example of a SHED graphic.  HelpBreeze adds a floating palette with a list of all the topic identifiers in your project so you can select the proper linkage for hotspots with a click of the mouse--rather than having to type identifiers.


Topic Wizard

This is one of HelpBreeze's most powerful features.  The Topic Wizard will automatically create and format a list of topics for you.  This can be an enormous time saver if you are developing a help file from scratch.


HelpBreeze Help

This icon gives you complete access to the HelpBreeze help system via a floating palette (similar to the browse palette in this help file).


The HelpBreeze Toolbar

The HelpBreeze toolbar provides easy access to visual tools which support virtually every feature of the Windows 3.1 help system.  The toolbar can be configured as a floating palette or attached to any edge of Word 6.0's main window.

Most HelpBreeze commands have a toolbar icon.  All commands are also available through menu selections and in many cases, through keyboard shortcuts.  The toolbar, menus and keyboard shortcuts are all fully customizable using the normal Word for Windows customization procedures.

To learn more about the toolbar functions, click any icon on the toolbar.  To see a short description in a pop-up window, check the Short Description box.  To see more detailed information on the feature, clear this box.


HelpBreeze was awarded the Windows Magazine recommended seal in a July, 1994 comparative review of 5 help authoring tools (Doc-To-Help, ForeHelp, HelpBreeze, MasterHelp and RoboHELP).

HelpBreeze 1.6 is the best help-authoring environment if you are already familiar with Word for Windows (especially if you are using 6.0)....an unusual blend of power for the professional...and simplicity for the beginner.

	Paul E. Schindler, Jr.		July, 1994


New Products

Solutionsoft is pleased to introduce two new products which build on the success of HelpBreeze:

HelpBreeze - Work Group Edition

HelpBreeze - Work Group Edition is the first help authoring tool specifically designed for development teams working on large-scale help systems.  The Work Group Edition includes all the features of the standard edition of HelpBreeze, plus unique tools which make it easy to break large projects down into individual modules and share information among team members.

For more information, please see HelpBreeze - Work Group Edition Features.

ViewerBreeze

ViewerBreeze brings the HelpBreeze interface and features to Microsoft's Multimedia Viewer and MediaView publishing Toolkits.  ViewerBreeze turns Word 6.0 or later into a complete, integrated environment for developing Viewer and MediaView titles.

For more information on ViewerBreeze, please see our ViewerBreeze demo VWRBRZ.ZIP.  This can be found in the WINMM forum on CompuServe or at various internet sites, (such as ftp.cica.indiana.edu).